Transforms forReportBean


ReportGraphDesignTransform

Formal Parameter Type Default Required Description
advancedDrillingContextMenuDisplay INTEGER 1 false It is used in the transform to specify whether to show the advanced drilling options in the editor or context menu.
Allowed Values: PreferencesDrillTransform.ADVANCED_DRILLING_RMC_DISPLAY_DEFAULT = "1"
ADVANCED_DRILLING_RMC_DISPLAY_SUBMENU = "2"
appliesTo STRING   false

This parameter informs the javascript the id of the bone the actions of this component applies to. For example, action of a Toolbar will be applied to the "grid" bone (in the Report page), or the the rwb_viewer (in the document's page).

Possible values for this property are bone ids, its usage depends on the page.
contextMenus STRING   false

This formal parameter is used by the Transform to identify the context-menus definition. The value of this parameter can specify either:

  1. The name of a <menu> defined in the pageConfig
  2. The path of an xml file with the context-menu definition

In both cases the xml defines the context-menus using <shortcut-list-set> tags. A <shortcut-list-set> represents a collection of <shortcut-list> tags. Each <shortcut-list> represents a single context-menu. Each <shortcut> represents a single option. Users can add/remove/modify <shortcut> to control the options displayed to the end user.
cssBottom STRING bottom false

Deprecated. css formatting is now applied through the layout-xml


This is the css name for the bottom area of the transform.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.
cssCenter STRING center false

Deprecated. css formatting is now applied through the layout-xml


This is the css name for the center area of the transform.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.
cssErrorMessage STRING error-message false

Deprecated. This formal parameter is not referenced anywhere in the code


This is the css name for the error message.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.
cssErrorTitle STRING error-title false

Deprecated. This formal parameter is not referenced anywhere in the code


This is the css name for the error title.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.
cssFile STRING   false CSS file that includes the style definition.
If defined, this file will be included as Link.
cssLeft STRING left false

Deprecated. css formatting is now applied through the layout-xml


This is the css name for the left area of the transform.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.
cssPrefix STRING   false Prefix to append to all css class names.
cssRight STRING right false

Deprecated. css formatting is now applied through the layout-xml


This is the css name for the right area of the transform.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.
cssTop STRING top false

Deprecated. css formatting is now applied through the layout-xml


This is the css name for the top area of the transform.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.
cssUseFileContent BOOLEAN false false This is the flag used in the transform to specify whether to show a link to the CSS file or the whole CSS file content.
Allowed Values: TRUE/FALSE.
customJavaScriptFeatures STRING   false name for the formal parameter "customJavaScriptFeatures".
datasetID STRING   false  
datasetName STRING   false  
debugErrorFlags INTEGER 65535 false Indicates which extra debug information to include in case of an error.
The flags are taken from the EnumWebAppDebugFlags enumeration.
debugFlags INTEGER 0 false Indicates which debug information to include.
The flags are taken from the EnumWebAppDebugFlags enumeration.
dragMode INTEGER 0 false Indicates the drag mode that the component to render will have.
Usage:
This tells us if the dialog can be dragged or docked (or both). Possible values for this property and their meaning include:
  • 1 = can be dragged freely (floating)
  • 2 = can be docked
  • 3 = 1 + 2 (can be dragged freely & docked)
    		•
    drillRetainThresholds STRING 3 false This is the FP which tells whether to retain the thresholds while drilling. If a value is specified here, then the drill Preference on the preference page for the same is ignored. This value can be 1(to retain), 0(to not retain) or 2(to use the drill path for the value). If blank the drill preference is used. Allowed Values:
    PreferencesDrillTransform.DRILL_OPTION_RETAIN_THRESHOLD_YES = "1";
    PreferencesDrillTransform.DRILL_OPTION_RETAIN_THRESHOLD_NO = "2";
    PreferencesDrillTransform.DRILL_OPTION_RETAIN_THRESHOLD_REPORT_DEFINITION = "3";
    extraInput STRING   false Indicates any extra inputs to be included in the forms generated by the transform.
    extraUrl STRING   false Indicates any extra parameters to be included in the links generated by the transform.
    globalCssErrorMessage STRING error-message false

    Deprecated. The css class to use for the title cannot be controlled by a Formal Parameter anymore.


    CSS to be used in all error messages.
    globalCssErrorTitle STRING error-title false

    Deprecated. The css class to use for the title cannot be controlled by a Formal Parameter anymore.


    CSS to be used in all Error titles.
    graphHeight INTEGER 400 false Graph Height to use.
    It's applicable only if _graphSize is set to PreferencesGraphTransform.GRAPH_USE_USER_SIZE.
    Allowed Values: integer values
    graphSize STRING   false Graph Size to use.
    Allowed Values:
    PreferencesGraphTransform.GRAPH_USE_REPORT_SIZE
    PreferencesGraphTransform.GRAPH_USE_USER_SIZE
    graphWidth INTEGER 700 false Graph Width to use.
    It's applicable only if _graphSize is set to PreferencesGraphTransform.GRAPH_USE_USER_SIZE.
    Allowed Values: integer values
    gridGraphUnitKeyContext STRING   false This formal parameter indicates the unique Id of the RWGridGraphControl. This will only apply to grids and graphs rendered inside Report Writing Documents. Allowed values:
    Any String
    groupContextMenuDrillPathsByType BOOLEAN false false Determines whether drill types (up, down, across and to template) will be displayed as read from the backend in which case the drill types may be intermingled or that we will buck the types together and show the types grouped together. The order will be up, down, across and to template. Default is false. Allowed Values: TRUE/FALSE.
    height STRING   false Indicates the default height of the component. If this is not a resizable component, this is the height used. If if it resizable, though, the user might change its width using javascript and the value is saved in a preference; thereafter the Transform will use this new value for this component.
    helpTopic STRING   false Indicates the help topic for the help page of the editor.
    helpType STRING user false Indicates the type of help topic this editor uses.
    id STRING   false It is used to identify the outer shell for all report modes - grid, graph and gridgraph. (Firefox issue: 246019)
    iframeEnabled BOOLEAN false false Indicates whether the transform supports iframe manipulations.
    imageSrc STRING   false This is the name which specifies the source of the graph image.
    Allowed Values: any file name used as the source of the graph image.
    imgError STRING jobError.gif false This is the Image to display when there bean is in Error status.
    Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    imgWait STRING ani_wait.gif false

    Deprecated. This value is not used anymore by the Transform as the wait image is included using css.


    Name of the image for the Processing icon on the Wait page.
    Allowed Values:
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    incrementalFetchStyleForRow STRING ReportStyleIncrementalFetch_2 false This is the name of the style used to show the incremental fetch for row.
    Allowed Values: any report style name from StyelCatalog.xml file.
    initialIndent INTEGER 0 false

    Deprecated. Indentation is not appended by Transforms anymore.


    Indicates the initial indentation of the HTML generated.
    isDisableGraphDrilling BOOLEAN false false This is the flag used in the transform to specify whether to disable drilling on the graph
    Allowed Values: TRUE/FALSE.
    isGraphSrcAddSessionInfo BOOLEAN false false This is the flag used in the transform to specify whether to include the session information on the image src of the graph
    Allowed Values: TRUE/FALSE.
    isGraphSrcFullPath BOOLEAN false false This is the flag used in the transform to specify whether to include the full path on the image src of the graph
    Allowed Values: TRUE/FALSE.
    quickSwitch BOOLEAN false false This formal parameter indicates if the grid is going to have the Quick Switch functionality (client side view mode change enabler) enabled. This will only apply to grids and graphs rendered inside Report Writing Documents. Allowed values:
    True and False
    renderDropZones INTEGER 0 false Indicates whether to render the graph drop zones.
    Usage:
    This tells us how to decide whether to render the graph drop zones or not. Possible values for this property and their meaning include:
  • EnumWebPreferences.PREFERENCE_YES = Always display
  • EnumWebPreferences.PREFERENCE_NO = Never display
  • EnumWebPreferences.PREFERENCE_VALUE_FROM_REPORT = (default) Resolves programatically based on user preference and if the object browser is open
    		•
    scriptClass STRING   false Holds the name of the javaScript class (if any) to be associated with the component. When the scriptClass is specified, a bone is registered on the page for this component. A bone is the corresponding concept of a bean in Microstrategy's javascript environment.
    By default, thie methods returns an empty string. Transform which does have an associated bone needs to override this method.
    showDrillPathSetNamesSubMenuAtTopLevel BOOLEAN true false It is used in the transform to specify whether to show the set names submenu for drilling at the top level (or at a lower depth).
    Allowed Values: TRUE/FALSE.
    showIncreFetchForColumn BOOLEAN true false

    Deprecated.


    It is used in the transform to specify whether to show increfetch links on column.
    Allowed Values: TRUE/FALSE.
    showIncreFetchForRowOnBottom BOOLEAN true false

    Deprecated.


    It is used in the transform to specify whether to show increfetch links for rows at the bottom of the grid.
    Allowed Values: TRUE/FALSE.
    showIncreFetchForRowOnTop BOOLEAN false false

    Deprecated.


    It is used in the transform to specify whether to show increfetch links for rows on top of the grid.
    Allowed Values: TRUE/FALSE.
    showSubtitle STRING 3 false Controls whether subtitles (attribute forms) are to be displayed for this grid. Allowed Values:
    showWidthHeightAttributes BOOLEAN true false This flag is used to decide if we need to include the WIDTH and HEIGHT on the IMG tag. (used for exporting to Excel).
    Allowed Values: TRUE/FALSE.
    shrinkGraphToHeight INTEGER -1 false Graph height to shrink to if graph height is bigger than this value.
    If it's -1, it means not shrink at all. Allowed Values: integer values
    shrinkGraphToWidth INTEGER -1 false Graph width to shrink to if graph width is bigger than this value.
    If it's -1, it means not shrink at all. Allowed Values: integer values
    sortSetNamesAndDrillPaths BOOLEAN false false It is used in the transform to specify whether to show the set names and drill paths names alphabetically sorted.
    Allowed Values: TRUE/FALSE.
    treeType STRING 1 false  
    useBuiltInFormat BOOLEAN true false This is the flag used in the transform to specify whether to use the formatting info from the report definition.
    Out of box, we map the first preference in Grid preferences section to this formal parameter.
    If it's TRUE, WebCSSHelper.getCSS() will give the css class definitions, which is from report formatting defintion.
    If it's FALSE, a specified css file will give the css class definitions, which is what formal paramter cssFile means.
    Allowed Values: TRUE/FALSE.
    useDHTML BOOLEAN true false Indicates whether to use DHTML on the output.
    If not set, the bean's OutputFormat() method will be used.
    useImageTag BOOLEAN false false Whether to force the use of an "img" tag (instead of an "input" tag)
    width STRING   false Indicates the default width of the component. If this is not a resizable component, this is the width used. If if it resizable, though, the user might change its width using javascript and the value is saved in a preference; thereafter the Transform will use this new value for this component.